DXCDT-255: Add new email provider manager and deprecate old one #129
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportBase: 95.39% // Head: 95.24% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## main #129 +/- ##
==========================================
- Coverage 95.39% 95.24% -0.16%
==========================================
Files 37 38 +1
Lines 6085 6310 +225
==========================================
+ Hits 5805 6010 +205
- Misses 226 241 +15
- Partials 54 59 +5
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
sergiught
commented
Nov 4, 2022
| @@ -19,6 +20,7 @@ type Email struct { | |||
| } | |||
|
|
|||
| // EmailCredentials are used for authenticating Email Providers. | |||
| // Deprecated: Use EmailProvider instead. | |||
| type EmailCredentials struct { | |||
| // API User | |||
| APIUser *string `json:"api_user,omitempty"` | |||
There was a problem hiding this comment.
To note that we're not adding the APIUser field to any of the credentials type within the new EmailProvider struct. This is because this field is no longer supported and trying to include it in the payload will result in a 400:
{
"statusCode": 400,
"error": "Bad Request",
"message": "Payload validation error: 'None of the valid schemas were met' on property credentials (Credentials required to use the provider). Inner errors: [ Payload validation error: 'Additional properties not allowed: api_user' on property credentials ({description}). ].",
"errorCode": "invalid_body"
}
Widcket
reviewed
Nov 4, 2022
Widcket
reviewed
Nov 4, 2022
Widcket
reviewed
Nov 4, 2022
Widcket
reviewed
Nov 4, 2022
Widcket
reviewed
Nov 4, 2022
Widcket
approved these changes
Nov 7, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🔧 Changes
Support for email provider settings has been requested through auth0/terraform-provider-auth0#384.
As we started adding this setting to the old
Emailstruct, it was noted that the DX wasn't good enough to be able to distinguish between what settings and even what credentials are specific to each email provider.To solve that we're introducing a brand new
EmailProviderstruct with specific credentials and settings for each email provider type.Also to avoid doing breaking changes we're just marking the old
Emailas deprecated and it will be removed in a future version.📚 References
auth0_emailto use the new go-auth0EmailProviderterraform-provider-auth0#393🔬 Testing
📝 Checklist